Skip to content

docs(discover): fix stale directory-scoped model tag examples#158

Merged
coketaste merged 1 commit into
developfrom
coketaste/docs-update-models-discover
Jul 15, 2026
Merged

docs(discover): fix stale directory-scoped model tag examples#158
coketaste merged 1 commit into
developfrom
coketaste/docs-update-models-discover

Conversation

@coketaste

Copy link
Copy Markdown
Collaborator

Summary

  • Corrects --tags examples for directory-scoped and dynamic model discovery across README.md, docs/cli-reference.md, and
    docs/usage.md — the old dummy2:dummy_2 colon syntax was stale and didn't match the actual {dir}/{model_or_tag} scoped-tag format.
  • Clarifies the extra-args-after-: syntax for dynamic models (e.g. dummy3/model3:batch_size=512).

Test plan

  • Docs-only change, no code affected
  • Visually confirm rendered examples in README.md, docs/cli-reference.md, docs/usage.md

Colon-separated tags (e.g. dummy2:dummy_2) are parsed as model name plus
extra script args, not directory scope. Directory-scoped selection uses
scope/tag syntax (e.g. dummy2/model1) since #109.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 15, 2026 20:40
@coketaste
coketaste merged commit 53363d9 into develop Jul 15, 2026
1 check passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates documentation to reflect the current madengine discover --tags syntax for directory-scoped discovery and dynamic model parameter passing, replacing an older colon-based example that no longer matches the implementation.

Changes:

  • Replace stale dummy2:dummy_2 examples with scoped-tag examples using {dir}/{model_or_tag} (e.g. dummy2/model1).
  • Clarify dynamic model extra-args syntax as suffix segments after : (e.g. dummy3/model3:batch_size=512).
  • Apply the updates consistently across the README and CLI/usage docs.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
README.md Updates model discovery examples to use {dir}/{model_or_tag} scoped tags and : for extra args.
docs/usage.md Clarifies directory-scoped selection and extra-args-after-: syntax with corrected examples.
docs/cli-reference.md Aligns CLI reference examples with the current scoped tag and extra-args formatting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

coketaste added a commit that referenced this pull request Jul 16, 2026
Summarizes the develop-vs-main delta: amd-smi path resolution fix,
unscoped tag matching for dir-prefixed model names, and corrected
directory-scoped tag examples in the docs.
@coketaste coketaste self-assigned this Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants